Skip to content

docs(linux): AM64X: Add ICSSG PRP Mode Docs#348

Merged
jeevantelukula merged 2 commits into
TexasInstruments:masterfrom
hm-ti:master
Jul 21, 2025
Merged

docs(linux): AM64X: Add ICSSG PRP Mode Docs#348
jeevantelukula merged 2 commits into
TexasInstruments:masterfrom
hm-ti:master

Conversation

@hm-ti

@hm-ti hm-ti commented Jul 8, 2025

Copy link
Copy Markdown
Contributor

Adds documentation on PRP offload mode supported by ICSSG

@github-actions

github-actions Bot commented Jul 9, 2025

Copy link
Copy Markdown

New warnings found with rstcheck:

source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:191: (ERROR/3) Error with CSV data in "csv-table" directive:

@danish-ti danish-ti left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

uditkumarti
uditkumarti previously approved these changes Jul 10, 2025
@github-actions

Copy link
Copy Markdown

New warnings found with rstcheck:

source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:191: (ERROR/3) Error with CSV data in "csv-table" directive:

Comment thread source/devices/AM64X/linux/Release_Specific_Release_Notes.rst Outdated

@StaticRocket StaticRocket left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please address the vale comments and fix the csv table currently generating errors.

@StaticRocket StaticRocket left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This probably should have been 3 commits with more reasonable information than just docs(linux): AM64X: Update docs, and that's without commenting on https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#commit-formatting

@github-actions

Copy link
Copy Markdown

New issues found with check_toc_txt.py:

WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:13 devices/AM62DX/linux/Release_Specific_Workarounds
WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:76 linux/How_to_Guides/Hardware_Setup_with_CCS/AM62DX_EVM_Hardware_Setup

@StaticRocket StaticRocket left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should use the feat tag, not the docs tag

@github-actions

Copy link
Copy Markdown

New issues found with check_toc_txt.py:

WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:7 devices/AM62DX/linux/Release_Specific_Release_Notes
WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:14 devices/AM62DX/linux/Release_Specific_Workarounds
WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:77 linux/How_to_Guides/Hardware_Setup_with_CCS/AM62DX_EVM_Hardware_Setup

@github-actions

Copy link
Copy Markdown

New warnings found with rstcheck:

source/devices/AM62DX/index.rst:33: (SEVERE/4) Problems with "include" directive path:

@StaticRocket

StaticRocket commented Jul 15, 2025

Copy link
Copy Markdown
Member

The commit tags need to be updated. You fixed the first one, but the second one is now wrong. I'd like to suggest:

feat(ICSSG): Add PRP mode docs for AM64X
feat(ICSSG): Update Release notes for AM64X

There are also some valid vale warnings (usage of linux instead of Linux, etc.)

@hm-ti hm-ti force-pushed the master branch 2 times, most recently from 1ae5cec to 681cc02 Compare July 16, 2025 08:53
- Adds documentation on ICSSG PRP offload mode supported by
prueth driver

Signed-off-by: Himanshu Mittal <h-mittal1@ti.com>
- Issue Tracker Update containing details of ICSSG firmware
    related bugs resolved and bugs open.
- Adds new PRP feature in What's New section

Signed-off-by: Himanshu Mittal <h-mittal1@ti.com>
@jeevantelukula jeevantelukula merged commit ec1f617 into TexasInstruments:master Jul 21, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants